home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / ldmud-3.2-bin.lha / mud / doc / LPC / comments < prev    next >
Text File  |  2001-07-02  |  1KB  |  45 lines
  1. NAME
  2.         comments
  3.  
  4. SYNTAX
  5.         /* block comment text */
  6.         // line comment text <end of line>
  7.  
  8.  
  9. DESCRIPTION
  10.         Comments are used to stored arbitrary text in the LPC program
  11.         source. It is a good idea if some if this text explains the
  12.         deeper intentions behind the actual LPC statements.
  13.  
  14.         There are block comments and line comments.
  15.  
  16.         Block comments start with a '/*' and end with a '*/'. They cannot
  17.         be nested, so
  18.         
  19.           /* this /* is */ illegal */
  20.  
  21.         will treat '/* this /* is */' as the comment.
  22.  
  23.         Line comments start with '//' and continue until the unescaped(!)
  24.         end of the line (as in the new C standard).
  25.  
  26.         It is not possible to next block and line comments within
  27.         each other. Meaning: '//' within /* ... */ has no special meaning,
  28.         neither does '/*' or '*/' have after a //.
  29.  
  30. EXAMPLES
  31.         /* Simple block comment */
  32.         
  33.         /* Block comments can
  34.            span several lines */
  35.  
  36.         // Simple line comment
  37.  
  38.         // Line comments can \
  39.            span several lines, too!
  40.  
  41.         //#define LONG_MACRO The unique behaviour \
  42.            or line comments regarding the end of line \
  43.            can be used for example to comment out a \
  44.            large macro with just to keystrokes.
  45.